home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / comm / yarn_091.zip / ENGLISH.DOC < prev    next >
Text File  |  1996-06-16  |  42KB  |  1,236 lines
  1.  
  2.  
  3. PC Yarn User Manual - version 0.91                                            
  4.  
  5.  
  6.               PC Yarn - offline news storage and reading system
  7.  
  8.      Copyright 1995 by Chin Huang
  9.  
  10.      Permission to copy and distribute this material for any purpose and
  11.      without fee is hereby granted, provided that the above copyright notice
  12.      and this permission notice appear in all copies.  The author makes no
  13.      representations about the accuracy or suitability of this material for
  14.      any purpose.  It is provided "as is", without any express or implied
  15.      warranties.  The author will assume no liability for damages either from
  16.      the direct use of this product or as a consequence of the use of this
  17.      product.
  18.  
  19.  
  20.                                  INTRODUCTION
  21.  
  22.      PC Yarn is a suite of programs for your personal computer, used to store
  23.      and read USENET news and mail downloaded from a USENET host.
  24.  
  25. FEATURES
  26.  
  27.      -  An import program inserts USENET articles into a "news base" from
  28.         Simple Offline USENET Packet (SOUP) format.  For each newsgroup, you
  29.         specify the number of days to keep articles, after which, an expire
  30.         program deletes them.  However, articles containing an Expires: header
  31.         are deleted on the date specified in the header.
  32.  
  33.      -  A mail filter moves incoming mail to specific folders or deletes
  34.         incoming mail based on user defined rules.
  35.  
  36.      -  The Yarn news reader presents articles in threads arranged by
  37.         Message-ID and References headers.  The reader program generates SOUP
  38.         reply packets.
  39.  
  40.      -  Score files contain rules to score articles based on matching text
  41.         found in the article.  The reader can be set up to not show articles
  42.         having scores below a certain threshold.
  43.  
  44.      -  Multiple users are supported by storing separate configuration files
  45.         for each user.
  46.  
  47. SYSTEM REQUIREMENTS
  48.  
  49.      -  MS-DOS 3.0 or higher
  50.  
  51.      -  compression software such as PKZIP and PKUNZIP
  52.  
  53.      -  80186 compatible CPU or better.  An 80386 compatible CPU or better is
  54.         required to run the 32-bit DOS extender programs.
  55.  
  56.      -  a lot of hard disk storage, depending on how much news you want to
  57.         keep.  For example, the author subscribes to 180 newsgroups and keeps
  58.         most articles for 7 days.  The amount of disk space used is 40
  59.         megabytes.
  60.  
  61.  
  62.  
  63.  
  64.                                                                              1
  65.  
  66.  
  67.  
  68. PC Yarn User Manual - version 0.91                                            
  69.  
  70.  
  71.                                  INSTALLATION
  72.  
  73. INSTALL YARN DIRECTORY
  74.  
  75.      Unpack the files from the Yarn distribution into a directory.  Run the
  76.      command
  77.  
  78.           english [drive:]directory
  79.  
  80.      where [drive:]directory specifies where to install the Yarn data
  81.      directory.  This directory is created if it doesn't already exist.
  82.      Choose a disk drive with a lot of free space because the news base will
  83.      be stored here.  In this document, this directory will be called the
  84.      %YARN% directory.
  85.  
  86. SET UP USER DIRECTORY
  87.  
  88.      To set up a user directory where Yarn will store your user information,
  89.      run the command
  90.  
  91.           adduser
  92.  
  93.      A form appears in which you fill in the required user information.
  94.  
  95.      + Add User ------------------------------------------------------------+
  96.      |                                                                      |
  97.      |    Home directory: C:\JIM                                            |
  98.      |                                                                      |
  99.      |           User ID: jsmith                                            |
  100.      |                                                                      |
  101.      |       Host system: netcom.com                                        |
  102.      |                                                                      |
  103.      |  User's full name: Jim Smith                                         |
  104.      |                                                                      |
  105.      |    Editor program: edit                                              |
  106.      |                                                                      |
  107.      | Reply packet file: C:\UPLOAD\IOXR.ZIP                                |
  108.      |                                                                      |
  109.      +----------------------------------------------------------------------+
  110.  
  111.      Home directory
  112.           Specify the directory where Yarn will store your user information.
  113.           This directory is created if it doesn't already exist.  In this
  114.           document, this directory will be called the %HOME% directory.
  115.  
  116.      User ID
  117.           Set this to your login name on the host from which you download and
  118.           upload USENET news.
  119.  
  120.      Host system
  121.           Set this to the full domain name of your host.
  122.  
  123.      User's full name
  124.           Set this to your full name.  This is the name that appears in
  125.           parentheses on the From: header in messages you send.
  126.  
  127.  
  128.  
  129.                                                                              2
  130.  
  131.  
  132.  
  133. PC Yarn User Manual - version 0.91                                            
  134.  
  135.  
  136.      Editor program
  137.           Set the name of the editor program to run when you send messages.
  138.  
  139.      Reply packet file
  140.           Specify the full path of the SOUP reply packet file where your
  141.           outgoing messages are stored.  If the reply packet file does not
  142.           exist, it is created when you post an article or send a mail message
  143.           from the reader program.  When you exit the reader program, the
  144.           reply packet is ready to upload to your host.
  145.  
  146.      The program writes the user information to a configuration file named
  147.      %HOME%\yarn\config.  This document refers to other configuration settings
  148.      also stored in this file.  If you want to change those settings, you have
  149.      to edit the configuration file with a text editor.
  150.  
  151. SET TIME ZONE
  152.  
  153.      Set the environment variable TZ to your time zone.  The format of the TZ
  154.      string is
  155.  
  156.           zzz[+/-]h[h][ddd]
  157.  
  158.      zzz is a three character field representing the name of the time zone.
  159.  
  160.      [+/-]h[h] is an optionally signed number representing the local time
  161.      zone's difference from Greenwich Mean Time (GMT) in hours.  Positive
  162.      numbers adjust westward from GMT.  Negative numbers adjust eastward from
  163.      GMT.
  164.  
  165.      ddd is an optional three character field that represents the name of the
  166.      local time zone's daylight saving time.
  167.  
  168.      If no TZ environment variable is set, a default TZ=EST5EDT is assumed.
  169.  
  170. UPDATE SYSTEM FILES
  171.  
  172.      Ensure the FILES setting in the CONFIG.SYS file is set to
  173.  
  174.           FILES=20
  175.  
  176.      or higher.  If there is no FILES setting, then add it.
  177.  
  178.      Put these SET commands in the AUTOEXEC.BAT file to ensure the environment
  179.      settings persist after the next time you reboot your system.  (If you are
  180.      installing Yarn for OS/2, put the SET commands in the CONFIG.SYS file
  181.      instead.)  Use the settings determined above for the values appearing to
  182.      the right of the equal signs.
  183.  
  184.           SET YARN=C:\YARN
  185.           SET HOME=C:\JIM
  186.           SET TZ=EST5EDT
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.                                                                              3
  195.  
  196.  
  197.  
  198. PC Yarn User Manual - version 0.91                                            
  199.  
  200.  
  201. SET UP OTHER USERS
  202.  
  203.      To set up another user, run the adduser command, and specify a different
  204.      home directory.  To run Yarn as that user, set the HOME environment
  205.      variable to the user's home directory.
  206.  
  207. ENVIRONMENT
  208.  
  209.      These enviroment variables modify the behaviour of Yarn if they are set.
  210.  
  211.      EDITOR    Specifies the external editor program, overriding the editor
  212.                specified in the configuration file.
  213.  
  214.      LOGDIR    Sets the user's home directory.  If LOGDIR is not set, the home
  215.                directory is set from the HOME environment variabl